<p>Packages:</p>
<ul class="simple">
<li>
<a href="#fleet.kurator.dev%2fv1alpha1">fleet.kurator.dev/v1alpha1</a>
</li>
</ul>
<h2 id="fleet.kurator.dev/v1alpha1">fleet.kurator.dev/v1alpha1</h2>
<p>Package v1alpha1 contains API Schema definitions for the fleet v1alpha1 API group</p>
Resource Types:
<ul class="simple"><li>
<a href="#fleet.kurator.dev/v1alpha1.Fleet">Fleet</a>
</li></ul>
<h3 id="fleet.kurator.dev/v1alpha1.Fleet">Fleet
</h3>
<p>Fleet represents a group of clusters, it is to consistently manage a group of clusters.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>apiVersion</code><br>
string</td>
<td>
<code>fleet.kurator.dev/v1alpha1</code>
</td>
</tr>
<tr>
<td>
<code>kind</code><br>
string
</td>
<td>
<code>Fleet</code>
</td>
</tr>
<tr>
<td>
<code>metadata</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
</td>
<td>
Refer to the Kubernetes API documentation for the fields of the
<code>metadata</code> field.
</td>
</tr>
<tr>
<td>
<code>spec</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.FleetSpec">
FleetSpec
</a>
</em>
</td>
<td>
<table>
<tr>
<td>
<code>clusters</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectreference-v1-core">
[]Kubernetes core/v1.ObjectReference
</a>
</em>
</td>
<td>
<p>Clusters represents the clusters that would be registered to the fleet.</p>
</td>
</tr>
<tr>
<td>
<code>plugin</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">
PluginConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Plugin defines the plugins that would be installed in the fleet.</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<code>status</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.FleetStatus">
FleetStatus
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.ChartConfig">ChartConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.GrafanaConfig">GrafanaConfig</a>, 
<a href="#fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig</a>, 
<a href="#fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig</a>, 
<a href="#fleet.kurator.dev/v1alpha1.ThanosConfig">ThanosConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>repository</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Repository defines the repository of chart.
Default value depends on the kind of the component.</p>
</td>
</tr>
<tr>
<td>
<code>name</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Name defines the name of the chart.
Default value depends on the kind of the component.</p>
</td>
</tr>
<tr>
<td>
<code>version</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Version defines the version of the chart.
Default value depends on the kind of the component.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.Endpoints">Endpoints
(<code>[]string</code> alias)</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.FleetStatus">FleetStatus</a>)
</p>
<h3 id="fleet.kurator.dev/v1alpha1.FleetPhase">FleetPhase
(<code>string</code> alias)</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.FleetStatus">FleetStatus</a>)
</p>
<h3 id="fleet.kurator.dev/v1alpha1.FleetSpec">FleetSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.Fleet">Fleet</a>)
</p>
<p>FleetSpec defines the desired state of the fleet</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>clusters</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectreference-v1-core">
[]Kubernetes core/v1.ObjectReference
</a>
</em>
</td>
<td>
<p>Clusters represents the clusters that would be registered to the fleet.</p>
</td>
</tr>
<tr>
<td>
<code>plugin</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">
PluginConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Plugin defines the plugins that would be installed in the fleet.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.FleetStatus">FleetStatus
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.Fleet">Fleet</a>)
</p>
<p>FleetStatus defines the observed state of the fleet</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>credentialSecret</code><br>
<em>
string
</em>
</td>
<td>
<p>CredentialSecret is the secret name that holds credentials used for accessing the fleet control plane.</p>
</td>
</tr>
<tr>
<td>
<code>phase</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.FleetPhase">
FleetPhase
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Phase represents the current phase of fleet.
E.g. Pending, Running, Terminating, Failed, Ready, etc.</p>
</td>
</tr>
<tr>
<td>
<code>reason</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>A brief CamelCase message indicating details about why the fleet is in this state.</p>
</td>
</tr>
<tr>
<td>
<code>pluginEndpoints</code><br>
<em>
map[<a href="">
string
</a>][<a href="#fleet.kurator.dev/v1alpha1.Endpoints">
Endpoints
</a>]
</em>
</td>
<td>
<p>PluginEndpoints is the endpoints of the plugins.</p>
</td>
</tr>
<tr>
<td>
<code>readyClusters</code><br>
<em>
int32
</em>
</td>
<td>
<p>TODO: healthy/unhealthy members cluster
Total number of ready clusters, ready to deploy .</p>
</td>
</tr>
<tr>
<td>
<code>unReadyClusters</code><br>
<em>
int32
</em>
</td>
<td>
<p>Total number of unready clusters, not ready for use.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.GrafanaConfig">GrafanaConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>chart</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ChartConfig">
ChartConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the grafana.
default values is</p>
<p>chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: grafana
version: 8.2.33</p>
</td>
</tr>
<tr>
<td>
<code>extraArgs</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Grafana chart.</p>
<p>For Example, using following configuration to change replica count.
extraArgs:
grafana:
replicaCount: 2</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PolicyConfig">PolicyConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>chart</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ChartConfig">
ChartConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the kyverno.
default values is
chart:
repository: <a href="https://kyverno.github.io/kyverno/">https://kyverno.github.io/kyverno/</a>
name: kyverno
version: 3.0.0</p>
</td>
</tr>
<tr>
<td>
<code>podSecurity</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PodSecurityPolicy">
PodSecurityPolicy
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>PodSecurity defines the pod security configuration for the kyverno.</p>
</td>
</tr>
<tr>
<td>
<code>extraArgs</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Grafana chart.</p>
<p>For Example, using following configuration to change image pull policy.
extraArgs:
image:
pullPolicy: Always</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.MetricConfig">MetricConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>thanos</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ThanosConfig">
ThanosConfig
</a>
</em>
</td>
<td>
<p>Thanos defines the configuration for the thanos querier and store gateway.</p>
</td>
</tr>
<tr>
<td>
<code>prometheus</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PrometheusConfig">
PrometheusConfig
</a>
</em>
</td>
<td>
<p>Prometheus defines the configuration for the prometheus installation
in the clusters observed by the thanos,
by default thanos sidecar will be installed in thanos sidecar mode.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.ObjectStoreConfig">ObjectStoreConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.ThanosConfig">ThanosConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>secretName</code><br>
<em>
string
</em>
</td>
<td>
<p>SecretName is the name of the secret that holds the object store configuration.
The path of object store configuration must be <code>objstore.yml</code></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.FleetSpec">FleetSpec</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>metric</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.MetricConfig">
MetricConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Metric defines the configuration for the monitoring system installation and metrics collection..</p>
</td>
</tr>
<tr>
<td>
<code>grafana</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.GrafanaConfig">
GrafanaConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Grafana defines the configuration for the grafana installation and observation.</p>
</td>
</tr>
<tr>
<td>
<code>policy</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PolicyConfig">
PolicyConfig
</a>
</em>
</td>
<td>
<p>Policy defines the configuration for the ploicy management.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.PodSecurityPolicy">PodSecurityPolicy
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>standard</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Standard defines the pod security standard.
More details: <a href="https://kubernetes.io/docs/concepts/security/pod-security-standards">https://kubernetes.io/docs/concepts/security/pod-security-standards</a></p>
</td>
</tr>
<tr>
<td>
<code>severity</code><br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Severity indicates policy check result criticality in a policy report.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.PolicyConfig">PolicyConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>kyverno</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.KyvernoConfig">
KyvernoConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Kyverno defines the configuration for the kyverno installation and policy management.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.MetricConfig">MetricConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>chart</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ChartConfig">
ChartConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the prometheus.
default values is</p>
<p>chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: kube-prometheus
version: 8.9.1</p>
</td>
</tr>
<tr>
<td>
<code>nodeExporter</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PrometheusExporterConfig">
PrometheusExporterConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>NodeExporter defines the configuration for the node exporter.</p>
</td>
</tr>
<tr>
<td>
<code>kubeStateMetrics</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.PrometheusExporterConfig">
PrometheusExporterConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>KubeStateMetrics defines the configuration for the kube-state-metrics.</p>
</td>
</tr>
<tr>
<td>
<code>extraArgs</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Prometheus chart.</p>
<p>For Example, using following configuration to create a ServiceMonitor to monitor prometheus itself.
extraArgs:
prometheus:
serviceMonitor:
enabled: true</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.PrometheusExporterConfig">PrometheusExporterConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>enabled</code><br>
<em>
bool
</em>
</td>
<td>
<p>Enabled indicates whether the exporters are enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.ThanosConfig">ThanosConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.MetricConfig">MetricConfig</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>chart</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ChartConfig">
ChartConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the thanos.
default values is</p>
<p>chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: thanos
version: 12.5.1</p>
</td>
</tr>
<tr>
<td>
<code>objectStoreConfig</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ObjectStoreConfig">
ObjectStoreConfig
</a>
</em>
</td>
<td>
<p>ObjectStoreConfig is the secret reference of the object store.
Configuration must follow the definition of the thanos: <a href="https://thanos.io/tip/thanos/storage.md/">https://thanos.io/tip/thanos/storage.md/</a>.</p>
</td>
</tr>
<tr>
<td>
<code>extraArgs</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Thanos chart.</p>
<p>For Example, using following configuration to enable query frontend.
extraArgs:
queryFrontend:
enabled: true</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="admonition note">
<p class="last">This page was automatically generated with <code>gen-crd-api-reference-docs</code></p>
</div>
